home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / librw / RWTValHashTableIterator.z / RWTValHashTableIterator
Encoding:
Text File  |  1998-10-30  |  5.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                    RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWTValHashTableIterator<T> - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/tvhasht.h>
  13.  
  14.  
  15.  
  16.               RWTValHashTable<T> table;
  17.           RWTValHashTableIterator<T> iterator(table);
  18.  
  19. PPPPlllleeeeaaaasssseeee NNNNooootttteeee!!!!
  20.      IIIIffff yyyyoooouuuu ddddoooo nnnnooootttt hhhhaaaavvvveeee tttthhhheeee SSSSttttaaaannnnddddaaaarrrrdddd CCCC++++++++ LLLLiiiibbbbrrrraaaarrrryyyy,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ddddeeeessssccccrrrriiiibbbbeeeedddd
  21.      hhhheeeerrrreeee....  OOOOtttthhhheeeerrrrwwwwiiiisssseeee,,,, uuuusssseeee tttthhhheeee iiiinnnntttteeeerrrrffffaaaacccceeee ttttoooo RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhMMMMuuuullllttttiiiiSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr
  22.      described in the Class Reference.
  23.  
  24.  
  25. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  26.      Iterator for class RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhTTTTaaaabbbblllleeee<<<<TTTT>>>>,,,, allowing sequential access to all
  27.      the elements of a hash table.  Elements are not accessed in any
  28.      particular order.  Like all Rogue Wave iterators, the "current item" is
  29.      undefined immediately after construction -- you must define it by using
  30.      ooooppppeeeerrrraaaattttoooorrrr(((()))) or some other (valid) operation.  Once the iterator has
  31.      advanced beyond the end of the collection it is no longer valid --
  32.      continuing to use it will bring undefined results.
  33.  
  34. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  35.      None
  36.  
  37. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  38.               RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr(RWTValHashTable<T>& c);
  39.  
  40.  
  41.      Constructs an iterator to be used with the table cccc.
  42.  
  43.  
  44.  
  45.  
  46.  
  47. PPPPuuuubbbblllliiiicccc OOOOppppeeeerrrraaaattttoooorrrrssss
  48.               RWBoolean
  49.           ooooppppeeeerrrraaaattttoooorrrr++++++++();
  50.  
  51.  
  52.      Advances the iterator one position.  Returns TTTTRRRRUUUUEEEE if the new position is
  53.      valid, FFFFAAAALLLLSSSSEEEE otherwise.
  54.  
  55.               RWBoolean
  56.           ooooppppeeeerrrraaaattttoooorrrr(((())))();
  57.  
  58.  
  59.      Advances the iterator one position.  Returns TTTTRRRRUUUUEEEE if the new position is
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                    RRRRWWWWTTTTVVVVaaaallllHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.      valid, FFFFAAAALLLLSSSSEEEE otherwise.
  75.  
  76. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  77.               RWTValHashTable<T>*
  78.           ccccoooonnnnttttaaaaiiiinnnneeeerrrr() const;
  79.  
  80.  
  81.      Returns a pointer to the collection over which this iterator is
  82.      iterating.
  83.  
  84.               T
  85.           kkkkeeeeyyyy() const;
  86.  
  87.  
  88.      Returns the value at the iterator's current position.  The results are
  89.      undefined if the iterator is no longer valid.
  90.  
  91.               void
  92.           rrrreeeesssseeeetttt();
  93.  
  94.  
  95.      Resets the iterator to the state it had immediately after construction.
  96.  
  97.               void
  98.           rrrreeeesssseeeetttt(RWTValHashTable<T>& c);
  99.  
  100.  
  101.      Resets the iterator to iterate over the collection cccc.
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.